﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using ScrumTable.DL.Data.Common.Config.Driver;
using ScrumTable.DL.Data.Common.Config.Schema;

#endregion

namespace ScrumTable.DL.Data.Common
{
    /// <summary>
    /// The IDataAssemblyInfo interface contains information about a plug in
    /// assembly and the data configuration facilities.
    /// </summary>
    public interface IDataAssemblyInfo
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the description of the data assembly. This property may be
        /// used in a UI drop down list in order to select a proprietary
        /// data connector plug in.
        /// </summary>
        string Description { get; }

        /// <summary>
        /// Returns true if the data assembly reqiures strong username / password authentication.
        /// </summary>
        bool AssemblyRequiresStrongAuthentication { get; }

        /// <summary>
        /// Specifies the data assembly format for the driver data source link (passed to the Connect()).
        /// </summary>
        DataSourceLinkFormat AssemblyRequiredLinkFormat { get; }

        /// <summary>
        /// Gets the schema data sources associated to the current data assembly and
        /// its data driver.
        /// </summary>
        IDataSchemaSelector DataSchemaSelector { get; }

        /// <summary>
        /// Gets the configuration data sources associated to the current data assembly and
        /// its data driver.
        /// </summary>
        IDriverConfigSelector DriverConfigSelector { get; }

        /// <summary>
        /// Gets the user specific configuration folder path for the current application.
        /// </summary>
        string ConfigFolderPath { get; }

        /// <summary>
        /// Gets the user specific data folder path for the current application.
        /// </summary>
        string DataFolderPath { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        /// <summary>
        /// Maps a file path to a file which is stored on the underlying 
        /// hard drive in conjunction with the data file-system data retrieval rules.
        /// </summary>
        /// <param name="fileToMap">Specifies the file path which should be mapped through the plugin system.</param>
        /// <returns>Returns a mapped file path which points the a file on the file system.</returns>
        string MapDataFilePath(string fileToMap);

        /// <summary>
        /// Maps a folder path to a file which is stored on the underlying 
        /// hard drive in conjunction with the data driver file-system data retrieval rules.
        /// </summary>
        /// <param name="folderToMap">Specifies the file path which should be mapped through the plugin system.</param>
        /// <returns>Returns a mapped file path which points the a file on the file system.</returns>
        string MapDataFolderPath(string folderToMap);

        /// <summary>
        /// Maps a file path to a file which is stored on the underlying 
        /// hard drive in conjunction with the config file-system data retrieval rules.
        /// </summary>
        /// <param name="fileToMap">Specifies the file path which should be mapped through the plugin system.</param>
        /// <returns>Returns a mapped file path which points the a file on the file system.</returns>
        string MapConfigFilePath(string fileToMap);

        /// <summary>
        /// Maps a folder path to a file which is stored on the underlying 
        /// hard drive in conjunction with the config driver file-system data retrieval rules.
        /// </summary>
        /// <param name="folderToMap">Specifies the file path which should be mapped through the plugin system.</param>
        /// <returns>Returns a mapped file path which points the a file on the file system.</returns>
        string MapConfigFolderPath(string folderToMap);

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}